Vcenter Vcha Cluster ActiveSpec

The Vcenter Vcha Cluster ActiveSpec schema contains the deploy specification for the Active Node of the VCHA cluster.

This schema was added in vSphere API 6.7.1.

JSON Example

{
    "ha_network_type": "string",
    "ha_network": "string",
    "ha_ip": {
        "ip_family": "string",
        "ipv4": {
            "address": "string",
            "subnet_mask": "string",
            "prefix": 0
        },
        "ipv6": {
            "address": "string",
            "prefix": 0
        },
        "default_gateway": "string",
        "dns_servers": [
            "string"
        ]
    }
}

string

ha_network_type

Optional

The type of the Network object used by the HA network.
If the Vcenter Vcha Cluster ActiveSpec.ha_network property is set, then the Vcenter Vcha Cluster ActiveSpec.ha_network_type field must be set.
If the Vcenter Vcha Cluster ActiveSpec.ha_network property is missing or null, then the Vcenter Vcha Cluster ActiveSpec.ha_network_type property is ignored.

For more information see: Vcenter Vcha NetworkType.

This property was added in vSphere API 6.7.1.

If missing or null and the Vcenter Vcha Cluster ActiveSpec.ha_network property is unset, then the second NIC is assumed to be already configured.
If missing or null and the Vcenter Vcha Cluster ActiveSpec.ha_network property is set, then an error is reported.

string

ha_network

Optional

The identifier of the Network object used for the HA network.
If the Vcenter Vcha Cluster ActiveSpec.ha_network property is set, then the Vcenter Vcha Cluster ActiveSpec.ha_network_type property must be set.
If the Vcenter Vcha Cluster ActiveSpec.ha_network property is missing or null, then the Vcenter Vcha Cluster ActiveSpec.ha_network_type property is ignored.

This property was added in vSphere API 6.7.1.

If missing or null and the Vcenter Vcha Cluster ActiveSpec.ha_network_type property is unset, then the second NIC is assumed to be already configured.
If missing or null and the Vcenter Vcha Cluster ActiveSpec.ha_network property is set, then an error is reported.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Network:VCenter. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Network:VCenter.

ha_ip

Required

IP specification for the HA network.

This property was added in vSphere API 6.7.1.